Embabel Agent Documentation/com.embabel.chat

Package-level declarations

Types

AssistantMessage

open class AssistantMessage constructor(content: String, val name: String? = null, val awaitable: Awaitable<*, *>? = null, val timestamp: Instant = Instant.now()) : Message, AssistantContent

Message sent by the assistant - currently text-only

AssistantMessageWithToolCalls

class AssistantMessageWithToolCalls constructor(content: String = "", val toolCalls: List<ToolCall>, val name: String? = null, val timestamp: Instant = Instant.now()) : AssistantMessage

An assistant message that includes tool calls. Extends AssistantMessage to include the tool calls the LLM wants to make.

interface Chatbot

A chatbot can conduct multiple chat sessions, each identified by a contextId.

interface ChatSession

Simplest possible conversation session implementation Responsible for keeping its conversation up to date via Conversation.addMessage(), and for sending messages to the OutputChannel.

sealed interface ContentPart

Represents a part of a multimodal message. This sealed interface ensures type safety and extensibility for future media types.

interface Conversation

Conversation shim for agent system. Mutable.

ConversationFormatter

fun interface ConversationFormatter

Format a conversation into a String for inclusion in a prompt. Note that we often prefer to use messages.

data class ImagePart(val mimeType: String, val data: ByteArray) : ContentPart

A part of a message containing image data.

sealed class Message : HasContent

Message class for agent system - now supports multimodal content

MessageFormatter

fun interface MessageFormatter

enum Role : Enum<Role>

Role of the message sender. For visible messages, not user messages.

SimpleMessageFormatter

object SimpleMessageFormatter : MessageFormatter

class SystemMessage constructor(content: String, val timestamp: Instant = Instant.now()) : Message

System message - text-only

data class TextPart(val text: String) : ContentPart

A part of a message containing text content.

data class ToolCall(val id: String, val name: String, val arguments: String)

Represents a tool call requested by the assistant.

ToolResultMessage

class ToolResultMessage constructor(val toolCallId: String, val toolName: String, content: String, val timestamp: Instant = Instant.now()) : Message

Message containing the result of a tool execution. This is sent back to the LLM after executing a tool.

class UserMessage : Message, UserContent

Message sent by the user - supports multimodal content

UserMessageBuilder

class UserMessageBuilder

Builder for creating multimodal UserMessages fluently

WindowingConversationFormatter

class WindowingConversationFormatter constructor(messageFormatter: MessageFormatter = SimpleMessageFormatter, windowSize: Int = 100, startIndex: Int = 0) : ConversationFormatter

Conversation formatter that shows the last windowSize messages, optionally skipping the first startIndex messages.

Functions

fun userMessage(): UserMessageBuilder

Create a UserMessage builder